#! /usr/bin/env python

import tensorflow as tf
import numpy as np
import os
import time
import datetime
import data_helpers
from text_cnn import TextCNN
from tensorflow.contrib import learn

# Parameters
# ==================================================

# Data loading params 语料文件路径
tf.flags.DEFINE_float("dev_sample_percentage", .1, "Percentage of the training data to use for validation")  # 训练:验证 = 9:1
tf.flags.DEFINE_string("positive_data_file", "./data/rt-polaritydata/rt-polarity.pos", "Data source for the positive data.")
tf.flags.DEFINE_string("negative_data_file", "./data/rt-polaritydata/rt-polarity.neg", "Data source for the negative data.")

# Model Hyperparameters 定义网络超参数
tf.flags.DEFINE_integer("embedding_dim", 128, "Dimensionality of character embedding (default: 128)")
tf.flags.DEFINE_string("filter_sizes", "3,4,5", "Comma-separated filter sizes (default: '3,4,5')")
tf.flags.DEFINE_integer("num_filters", 128, "Number of filters per filter size (default: 128)")
tf.flags.DEFINE_float("dropout_keep_prob", 0.5, "Dropout keep probability (default: 0.5)")
tf.flags.DEFINE_float("l2_reg_lambda", 0.0, "L2 regularization lambda (default: 0.0)")

# Training parameters 训练参数
tf.flags.DEFINE_integer("batch_size", 64, "Batch Size (default: 64)")  # 一批次的数据量大小
tf.flags.DEFINE_integer("num_epochs", 200, "Number of training epochs (default: 200)")  # 迭代次数
tf.flags.DEFINE_integer("evaluate_every", 100, "Evaluate model on dev set after this many steps (default: 100)")  # 多少step测试一下模型
tf.flags.DEFINE_integer("checkpoint_every", 100, "Save model after this many steps (default: 100)")  # 多少step保存一下模型
tf.flags.DEFINE_integer("num_checkpoints", 5, "Number of checkpoints to store (default: 5)")  # 最多保存多少个模型

# Misc Parameters
tf.flags.DEFINE_boolean("allow_soft_placement", True, "Allow device soft device placement")  # tf自动选择设备运行
tf.flags.DEFINE_boolean("log_device_placement", False, "Log placement of ops on devices")  # 指派op和tensor到设备上运行

# 打印一下相关初始参数
FLAGS = tf.flags.FLAGS
FLAGS._parse_flags()

print("\nParameters:")
for attr, value in sorted(FLAGS.__flags.items()):
    print("{}={}".format(attr.upper(), value))
print("")

"""
训练时，可以在命令行修改以上的参数
例如：python train.py --batch_size=128
"""

# Data Preparation
# ==================================================

# Load data
print("Loading data...")
'''
x_text：文本列表。列表元素为分好词的文本
y：类别列表。列表元素为一个向量，其维度为类别的数目
'''
x_text, y = data_helpers.load_data_and_labels(FLAGS.positive_data_file, FLAGS.negative_data_file)

# Build vocabulary 建立词汇表
max_document_length = max([len(x.split(" ")) for x in x_text])  # 求每行文本分词的最大个数
vocab_processor = learn.preprocessing.VocabularyProcessor(max_document_length)  # 建立一个词典
x = np.array(list(vocab_processor.fit_transform(x_text)))  # 将每行的分词转换成词典中的编号，不足max_document_length补0

# Randomly shuffle data 数据洗牌
np.random.seed(10)  # 生成随机序列
shuffle_indices = np.random.permutation(np.arange(len(y)))  # 返回一个1*n的矩阵，里面元素顺序是打乱的
x_shuffled = x[shuffle_indices]  # 文本行的索引
y_shuffled = y[shuffle_indices]  # 文本行类别的索引

# Split train/test set 将数据按训练和测试分块
# TODO: This is very crude, should use cross-validation
dev_sample_index = -1 * int(FLAGS.dev_sample_percentage * float(len(y)))  # 后10%的下标
x_train, x_dev = x_shuffled[:dev_sample_index], x_shuffled[dev_sample_index:]
y_train, y_dev = y_shuffled[:dev_sample_index], y_shuffled[dev_sample_index:]  # x：文本向量，y：类别向量
print("Vocabulary Size: {:d}".format(len(vocab_processor.vocabulary_)))
print("Train/Dev split: {:d}/{:d}".format(len(y_train), len(y_dev)))


# Training 训练
# =======================================================================================================

with tf.Graph().as_default():
    """
    设置 allow_soft_placement 参数：在优先设备不存在时，允许 TensorFlow 回退到特定操作的设备。
    比如，我们的代码是运行在一个GPU上面的，但是在一个没有GPU的机器上运行了，那么如果不使用 allow_soft_placement 参数，程序就会报错。
    设置 log_device_placement 参数：TensorFlow 会记录它运行操作的设备（CPU或者GPU）。
    这对调试程序非常有用，FLAGS 是我们程序的命令行参数。
    """
    session_conf = tf.ConfigProto(
      allow_soft_placement=FLAGS.allow_soft_placement,
      log_device_placement=FLAGS.log_device_placement)
    sess = tf.Session(config=session_conf)

    with sess.as_default():
        # 实例化 卷积池化网络导入
        """实现卷积神经网络和损失函数最小化"""
        cnn = TextCNN(
            sequence_length=x_train.shape[1],  # 词向量的列数，即句长
            num_classes=y_train.shape[1],  # 类别的列数，即类别数量
            vocab_size=len(vocab_processor.vocabulary_),  # 词的数量
            embedding_size=FLAGS.embedding_dim,  # 词向量维度
            filter_sizes=list(map(int, FLAGS.filter_sizes.split(","))),  # 上面定义的filter_sizes拿过来，"3,4,5"按","分割
            num_filters=FLAGS.num_filters,  # 几个filter
            l2_reg_lambda=FLAGS.l2_reg_lambda)  # l2正则化项

        # Define Training procedure
        """
        定义如何最优化网络的损失函数：TensorFlow有很多内嵌的优化函数，这里使用Adam优化器。
        代码中，trian_op 是一个新创建的操作，我们可以运行它来对我们的参数进行梯度更新。
        每次执行 train_op 操作，就是一个训练步骤。TensorFlow 会自动计算出哪些变量是“可训练”的，并计算它们的梯度。
        通过定义 global_step 变量并将它传递给优化器，我们允许TensorFlow处理我们的训练步骤。
        我们每次执行 train_op 操作时，global_step 都会自动递增1。
        """
        global_step = tf.Variable(0, name="global_step", trainable=False)
        optimizer = tf.train.AdamOptimizer(1e-3)  # 定义优化器
        grads_and_vars = optimizer.compute_gradients(cnn.loss)
        train_op = optimizer.apply_gradients(grads_and_vars, global_step=global_step)

        # Keep track of gradient values and sparsity (optional)
        grad_summaries = []
        for g, v in grads_and_vars:
            if g is not None:
                grad_hist_summary = tf.summary.histogram("{}/grad/hist".format(v.name), g)
                sparsity_summary = tf.summary.scalar("{}/grad/sparsity".format(v.name), tf.nn.zero_fraction(g))
                grad_summaries.append(grad_hist_summary)
                grad_summaries.append(sparsity_summary)
        grad_summaries_merged = tf.summary.merge(grad_summaries)

        """
        汇总：
        TensorFlow 有一个汇总的概念，它允许你在训练和评估阶段来跟踪和可视化各种参数。
        比如，你可能想要去跟踪在各个训练和评估阶段，损失值和正确值是如何变化的。
        当然，你还可以跟踪更加复杂的数据。例如，图层激活的直方图。
        汇总是一个序列化对象，我们可以使用 SummaryWriter 函数来将它们写入磁盘。
        在这里，我们独立的去处理训练阶段和评估阶段的汇总。在我们的例子中，在训练阶段和评估阶段，我们记录的汇总数据都是一样的。
        但是，你可能会有一些汇总数据是只想在训练阶段进行记录的（比如，参数更新值）。
        tf.merge_summary 是一个方便的函数，它可以将多个汇总操作合并到一个我们可以执行的单个操作中。
        """
        # Output directory for models and summaries
        timestamp = str(int(time.time()))
        out_dir = os.path.abspath(os.path.join(os.path.curdir, "runs", timestamp))
        print("Writing to {}\n".format(out_dir))

        # Summaries for loss and accuracy
        loss_summary = tf.summary.scalar("loss", cnn.loss)
        acc_summary = tf.summary.scalar("accuracy", cnn.accuracy)

        # Train Summaries
        train_summary_op = tf.summary.merge([loss_summary, acc_summary, grad_summaries_merged])
        train_summary_dir = os.path.join(out_dir, "summaries", "train")
        train_summary_writer = tf.summary.FileWriter(train_summary_dir, sess.graph)

        # Dev summaries
        dev_summary_op = tf.summary.merge([loss_summary, acc_summary])
        dev_summary_dir = os.path.join(out_dir, "summaries", "dev")
        dev_summary_writer = tf.summary.FileWriter(dev_summary_dir, sess.graph)

        """
        检查点：
        在TensorFlow中，另一个你通常想要的功能是检查点（checkpointing）——保存模型的参数以备以后恢复。
        检查点可用于在以后的继续训练，或者提前来终止训练，从而能来选择最佳参数。检查点是使用 Saver 对象来创建的。
        """
        # Checkpoint directory. Tensorflow assumes this directory already exists so we need to create it
        checkpoint_dir = os.path.abspath(os.path.join(out_dir, "checkpoints"))
        checkpoint_prefix = os.path.join(checkpoint_dir, "model")
        if not os.path.exists(checkpoint_dir):
            os.makedirs(checkpoint_dir)
        saver = tf.train.Saver(tf.global_variables(), max_to_keep=FLAGS.num_checkpoints)

        # Write vocabulary
        vocab_processor.save(os.path.join(out_dir, "vocab"))

        """
        初始化变量：
        initialize_all_variables 函数是一个方便的函数，它能帮助我们去初始化所有的变量。
        当然你也能手动初始化你自己的参数。手动初始化是非常有用的，比如你想要去初始化你的词向量（嵌入层），用与训练好的词向量模型。
        """
        # Initialize all variables
        sess.run(tf.global_variables_initializer())

        """
        定义单个训练步骤：
        现在我们定义一个训练函数，用于单个训练步骤，在一批数据上进行评估，并且更新模型参数。
        feed_dict 包含了我们需要传入到网络中的数据。你必须为所有的占位符节点提供值，否则TensorFlow会报错。
        使用 session.run 来执行我们的 train_op ，它会返回我们要求它评估的所有操作的值。
        注意，train_op 不返回任何东西，它只是更新我们的网络参数。
        最后，我们打印当前训练的损失值和正确值，并且把汇总结果保存到磁盘。
        请注意，如果批处理规模很小，那么损失值和模型正确值可能在不同批次之间会有很大的不同。
        因为我们使用了 Dropout ，所以我们的训练正确率可能会比测试正确率低一点。
        """
        def train_step(x_batch, y_batch):
            """
            A single training step
            """
            feed_dict = {
              cnn.input_x: x_batch,
              cnn.input_y: y_batch,
              cnn.dropout_keep_prob: FLAGS.dropout_keep_prob
            }
            _, step, summaries, loss, accuracy = sess.run(
                [train_op, global_step, train_summary_op, cnn.loss, cnn.accuracy],
                feed_dict)
            time_str = datetime.datetime.now().isoformat()  # 取当前时间
            print("{}: step {}, loss {:g}, acc {:g}".format(time_str, step, loss, accuracy))
            train_summary_writer.add_summary(summaries, step)

        def dev_step(x_batch, y_batch, writer=None):
            """
            Evaluates model on a dev set
            """
            feed_dict = {
              cnn.input_x: x_batch,
              cnn.input_y: y_batch,
              cnn.dropout_keep_prob: 1.0  # 神经元全部保留
            }
            step, summaries, loss, accuracy = sess.run(
                [global_step, dev_summary_op, cnn.loss, cnn.accuracy],
                feed_dict)
            time_str = datetime.datetime.now().isoformat()
            print("{}: step {}, loss {:g}, acc {:g}".format(time_str, step, loss, accuracy))
            if writer:
                writer.add_summary(summaries, step)

        """
        循环训练：
        最后，完整的训练过程。
        我们对数据集进行批次迭代操作，为每个批处理调用一次 train_step 函数，偶尔去评估一下我们的训练模型。
        这里，batch_iter 是一个我批处理数据的帮助函数，tr.train.global_step 是一个方便函数，它返回 global_step 的值。
        """
        # Generate batches
        '''
        zip(x_train, y_train) 每一行为： [文本向量] [类别向量]
        迭代产生一批量的数据为：batches
        '''
        batches = data_helpers.batch_iter(list(zip(x_train, y_train)), FLAGS.batch_size, FLAGS.num_epochs)
        # Training loop. For each batch...
        for batch in batches:
            x_batch, y_batch = zip(*batch)  # 按batch把数据拿出来
            train_step(x_batch, y_batch)  # 训练得到模型
            current_step = tf.train.global_step(sess, global_step)  # 将Session和global_step值传进来
            if current_step % FLAGS.evaluate_every == 0:  # 每FLAGS.evaluate_every次每100执行一次测试
                print("\nEvaluation:")
                dev_step(x_dev, y_dev, writer=dev_summary_writer)  # 每evaluate_every次验证一遍准确率
                print("")
            if current_step % FLAGS.checkpoint_every == 0:  # 每checkpoint_every次执行一次保存模型
                path = saver.save(sess, checkpoint_prefix, global_step=current_step)  # 定义模型保存路径
                print("Saved model checkpoint to {}\n".format(path))
